Skip to main content

DH APP/API Deployment Guide

1. Overview​

This document provides deployment-related information for the DH API services.

For detailed installation and configuration instructions, refer to the DH API Installation Guide.

Whenever a new configuration parameter or deployment-related setting is introduced, the Development Team will communicate the change to the Deployment Team. If required, a knowledge transfer or demonstration session will be conducted to ensure proper understanding and implementation.

This process helps minimize communication gaps and ensures smooth deployment activities.

2. Health API​

A new Health API endpoint has been introduced to simplify service monitoring and operational validation.

The endpoint is available on both:

  • Orchestrator
  • Executor

3. Orchestrator Health Endpoint​

When the Health API is invoked through the Orchestrator URL:

  • The Orchestrator internally queries all Executors configured in the ExecutorDef table.

  • The response includes the connectivity status of each configured Executor.

  • Additional service metadata is also returned, including:

    • Orchestrator Version
    • DH API Version
    • DH PROD Version
    • Executor details (status, state, version, and connectivity)

This endpoint can be used to quickly verify the overall health of the DH API ecosystem.

Sample Response 

{
  "orchestrator_version": "6.9.3",
  "dh_api_version": "6.1.4",
  "dh_prod_version": "4.3.1",
  "executors": [
    {
      "executor_id": "5",
      "executor_addresss": "127.0.0.1:8080",
      "status": "Up",
      "state": "Enabled",
      "status_details": "Healthy",
      "executor_version": "6.4.3",
      "dh_api_version": "5.0.9"
    },
    {
      "executor_id": "2",
      "executor_addresss": "192.168.66.91:6346",
      "status": "Down",
      "state": "Enabled",
      "status_details": "HTTP error status: 404 Not Found",
      "executor_version": "",
      "dh_api_version": ""
    }
  ]
}

4. Executor Health Endpoint​

When the Health API is invoked directly through an Executor URL:

  • The endpoint returns the operational status of the Executor service.
  • It can be used to verify that the Executor is running and accessible.
  • The response includes the Executor version and the associated DH API version.

Sample Response 

{
  "executor_version": "6.4.4",
  "dh_api_version": "6.1.4"
}

5. Usage​

The Health API can be invoked using standard HTTP GET requests.

5.1 Example Using CURL​

curl -X GET http://127.0.0.1:8000/health

5.2 Example Using a Web Browser​

Navigate to:

http://127.0.0.1:8000/health

6. Purpose​

The Health API provides a simple mechanism to:

  • Verify service availability.
  • Validate Executor connectivity from the Orchestrator.
  • Check deployed component versions.
  • Troubleshoot deployment and infrastructure issues.
  • Confirm successful deployment of DH API services.

7. Response Fields​

FieldDescription
orchestrator_versionVersion of the Orchestrator service.
executor_versionVersion of the Executor service.
dh_api_versionVersion of the DH API deployed with the service.
dh_prod_versionCurrently deployed DH PROD version.
statusAvailability status of the Executor (Up/Down).
stateExecutor state configured in the Orchestrator (Enabled/Disabled).
status_detailsAdditional information describing the Executor's current status or any communication error.